<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.doc.model</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.doc-module.html">Package&nbsp;doc</a> ::
        Module&nbsp;model
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.doc.model-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module model</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#dump" class="summary-sig-name">dump</a>(<span class="summary-sig-arg">filename</span>)</span><br />
      Use the dump command to save a snapshot copy of the current model to 
      the specified filename and location, without changing the stored 
      filename or marking the model as having been recently saved.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#dump">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#export_file" class="summary-sig-name">export_file</a>(<span class="summary-sig-arg">filename</span>,
        <span class="summary-sig-arg">fileformat</span>)</span><br />
      Use this command to export the current model data to the a file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#export_file">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#import_file" class="summary-sig-name">import_file</a>(<span class="summary-sig-arg">filename</span>)</span><br />
      Use this command to import data in into the current model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#import_file">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#load" class="summary-sig-name">load</a>(<span class="summary-sig-arg">filename</span>)</span><br />
      Loads the specified file as the current model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#load">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#load_new" class="summary-sig-name">load_new</a>()</span><br />
      Clears the current model from memory and resets the material library.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#load_new">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#revert" class="summary-sig-name">revert</a>()</span><br />
      Use this command to revert to the last saved version of the current 
      model file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#revert">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#save" class="summary-sig-name">save</a>()</span><br />
      This command simply saves the current model to disk.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#save">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#save_as" class="summary-sig-name">save_as</a>(<span class="summary-sig-arg">filename</span>)</span><br />
      When invoked, the model.saveas command saves the model with the new 
      filename, copies its adjacency and shading table files, then updates 
      the stored model filename and the main window caption.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#save_as">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#update" class="summary-sig-name">update</a>()</span><br />
      Use the update command to check and refresh inter-object 
      relationships within the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#update">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_altitude" class="summary-sig-name">get_altitude</a>(<span class="summary-sig-arg">absolute_position_start</span>,
        <span class="summary-sig-arg">absolute_position_end</span>)</span><br />
      Retrieves geometric information from the current ECOTECT model, 
      specifically the vertical angular distance of a line starting at (x1,
      y1, z1) and travelling towards var&gt;(x2, y2, z2).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_altitude">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_azimuth" class="summary-sig-name">get_azimuth</a>(<span class="summary-sig-arg">absolute_position_start</span>,
        <span class="summary-sig-arg">absolute_position_end</span>)</span><br />
      Retrieves geometric information from the current ECOTECT model, 
      specifically the horizontal angular distance of a line starting at 
      (x1, y1, z1) and travelling towards var&gt;(x2, y2, z2).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_azimuth">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_current_node" class="summary-sig-name">get_current_node</a>()</span><br />
      Returns the zero-based index of the last selected node within the 
      currently loaded ECOTECT model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_current_node">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#set_current_object" class="summary-sig-name">set_current_object</a>()</span><br />
      Returns the Szero-based index of the last selected object within the 
      currently loaded ECOTECT model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_current_object">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_current_zone" class="summary-sig-name">get_current_zone</a>()</span><br />
      Returns the zero-based index of the current zone in the currently 
      loaded ECOTECT model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_current_zone">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_date" class="summary-sig-name">get_date</a>()</span><br />
      Retrieves the current date as a formatted string ready for printing 
      or output to a file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_date">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#set_date" class="summary-sig-name">set_date</a>(<span class="summary-sig-arg">day</span>,
        <span class="summary-sig-arg">month</span>,
        <span class="summary-sig-arg">time</span>=<span class="summary-sig-default">None</span>)</span><br />
      Sets the date in the ECOTECT model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_date">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_date_string" class="summary-sig-name">get_date_string</a>()</span><br />
      Retrieves a formated string containing the current model date.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_date_string">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_daylight_savings" class="summary-sig-name">get_daylight_savings</a>()</span><br />
      Retrieves the status of the daylight savings flag.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_daylight_savings">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#set_daylight_savings" class="summary-sig-name">set_daylight_savings</a>(<span class="summary-sig-arg">state</span>)</span><br />
      Sets the status of the daylight savings flag.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_daylight_savings">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_day_of_the_year" class="summary-sig-name">get_day_of_the_year</a>()</span><br />
      Retrieves the current date and displays it in the julian date format,
      where a single integer value between 1 and 365 represents a day of 
      the year.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_day_of_the_year">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#set_day_of_the_year" class="summary-sig-name">set_day_of_the_year</a>(<span class="summary-sig-arg">day</span>,
        <span class="summary-sig-arg">time</span>=<span class="summary-sig-default">None</span>)</span><br />
      Sets the current date using the julian date format.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_day_of_the_year">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_directory" class="summary-sig-name">get_directory</a>()</span><br />
      Returns the drive and directory in which the currently loaded ECOTECT
      model is located.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_directory">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#set_directory" class="summary-sig-name">set_directory</a>(<span class="summary-sig-arg">path</span>)</span><br />
      Sets the drive and directory to use with the currently loaded ECOTECT
      model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_directory">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_display" class="summary-sig-name">get_display</a>()</span><br />
      Retrieves the current information display.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_display">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#set_display" class="summary-sig-name">set_display</a>(<span class="summary-sig-arg">display</span>)</span><br />
      This property sets the current information display.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_display">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_distance" class="summary-sig-name">get_distance</a>(<span class="summary-sig-arg">absolute_position_start</span>,
        <span class="summary-sig-arg">absolute_position_end</span>)</span><br />
      Retrieves geometric information from the current ECOTECT model, 
      specifically the distance between two points, starting at (x1, y1, 
      z1) and ending at (x2, y2, z2).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_distance">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_filename" class="summary-sig-name">get_filename</a>()</span><br />
      Returns the filename of the currently loaded ECOTECT model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_filename">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_last_node_index" class="summary-sig-name">get_last_node_index</a>()</span><br />
      Returns the zero-based index of the last added/inserted node within 
      the currently loaded ECOTECT model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_last_node_index">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#num_materials" class="summary-sig-name">num_materials</a>()</span><br />
      Returns the number of materials stored in the currently loaded 
      ECOTECT model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#num_materials">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_month" class="summary-sig-name">get_month</a>()</span><br />
      Returns the current month.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_month">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_next_node" class="summary-sig-name">get_next_node</a>(<span class="summary-sig-arg">object</span>,
        <span class="summary-sig-arg">node</span>)</span><br />
      Returns the zero-based absolute index of the next node in the 
      specified object, in relation to the current node.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_next_node">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_next_object" class="summary-sig-name">get_next_object</a>(<span class="summary-sig-arg">startat</span>,
        <span class="summary-sig-arg">type</span>,
        <span class="summary-sig-arg">flag</span>,
        <span class="summary-sig-arg">tag</span>,
        <span class="summary-sig-arg">zone</span>)</span><br />
      Use this property to obtain the zero-based index of the next object 
      matching the type, flag and tag values specified.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_next_object">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_orientation" class="summary-sig-name">get_orientation</a>(<span class="summary-sig-arg">absolute_position_start</span>,
        <span class="summary-sig-arg">absolute_position_end</span>)</span><br />
      Retrieves geometric information from the current ECOTECT model, 
      specifically the relative horizontal angle from North of a line 
      starting at (x1, y1, z1) and travelling towards var&gt;(x2, y2, z2).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_orientation">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_origin" class="summary-sig-name">get_origin</a>()</span><br />
      Retrieves the location of the Transformation Origin.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_origin">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#set_origin" class="summary-sig-name">set_origin</a>(<span class="summary-sig-arg">absolute_position</span>)</span><br />
      Sets the location of the Transformation Origin.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_origin">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_path_name" class="summary-sig-name">get_path_name</a>()</span><br />
      Returns the full pathname of the currently loaded ECOTECT model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_path_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_prev_node" class="summary-sig-name">get_prev_node</a>(<span class="summary-sig-arg">object</span>,
        <span class="summary-sig-arg">node</span>)</span><br />
      Returns the zero-based absolute index of the previous node in the 
      specified object, in relation to the current node.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_prev_node">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_prev_object" class="summary-sig-name">get_prev_object</a>(<span class="summary-sig-arg">startat</span>,
        <span class="summary-sig-arg">type</span>,
        <span class="summary-sig-arg">flag</span>,
        <span class="summary-sig-arg">tag</span>,
        <span class="summary-sig-arg">zone</span>)</span><br />
      Use this property to obtain the zero-based index of the preceding 
      object matching the type, flag and tag values specified.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_prev_object">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_snap" class="summary-sig-name">get_snap</a>()</span><br />
      Retrieves the current information display</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_snap">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#set_snap" class="summary-sig-name">set_snap</a>(<span class="summary-sig-arg">snap</span>)</span><br />
      This property sets the current information display.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_snap">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_sun_angles" class="summary-sig-name">get_sun_angles</a>()</span><br />
      Returns two values, being the azimuth and altitude of the Sun for the
      current date and time, given in decimal degrees.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_sun_angles">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_sun_position" class="summary-sig-name">get_sun_position</a>(<span class="summary-sig-arg">dist</span>=<span class="summary-sig-default">0</span>,
        <span class="summary-sig-arg">xyz</span>=<span class="summary-sig-default"><code class="variable-group">(</code>0<code class="variable-op">, </code>0<code class="variable-op">, </code>0<code class="variable-group">)</code></span>)</span><br />
      Returns a position value that can be used to represent the Sun 
      location relative to the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_sun_position">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_sunrise" class="summary-sig-name">get_sunrise</a>()</span><br />
      Returns the sunrise time as a 24 hour decimal value.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_sunrise">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_sun_set" class="summary-sig-name">get_sun_set</a>()</span><br />
      Returns the sunset time as a 24 hour decimal value.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_sun_set">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_time" class="summary-sig-name">get_time</a>()</span><br />
      Retrieves the current time of day.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#set_time" class="summary-sig-name">set_time</a>(<span class="summary-sig-arg">time</span>)</span><br />
      Sets the current time of day.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_time">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_time_string" class="summary-sig-name">get_time_string</a>()</span><br />
      Retrieves a formated string containing the current model time.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_time_string">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_flag_cap_extrusions" class="summary-sig-name">get_flag_cap_extrusions</a>()</span><br />
      Retrieves the capextrusions flag.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_flag_cap_extrusions">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#set_flag_cap_extrusions" class="summary-sig-name">set_flag_cap_extrusions</a>(<span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span><br />
      Sets the capextrusions flag.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_flag_cap_extrusions">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_flag_vectors" class="summary-sig-name">get_flag_vectors</a>()</span><br />
      Retrieves the xform.vectors flag.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_flag_vectors">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#set_flag_vectors" class="summary-sig-name">set_flag_vectors</a>(<span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span><br />
      Returns the number of zones in the currently loaded ECOTECT model as 
      a single integer.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_flag_vectors">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_num_nodes" class="summary-sig-name">get_num_nodes</a>()</span><br />
      Returns the number of individual object nodes within the currently 
      loaded ECOTECT model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_num_nodes">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_num_objects" class="summary-sig-name">get_num_objects</a>()</span><br />
      Returns the number of objects in the currently loaded ECOTECT model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_num_objects">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.model-module.html#get_zones" class="summary-sig-name">get_zones</a>()</span><br />
      Returns the number of zones in the currently loaded ECOTECT model as 
      a single integer.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_zones">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="dump"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">dump</span>(<span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#dump">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use the dump command to save a snapshot copy of the current model to 
  the specified filename and location, without changing the stored filename
  or marking the model as having been recently saved. This command can be 
  useful when performing a large number of parametric calculations and wish
  to generate several interim results files without all the information 
  usually associated with a model.saveas command. As a comparison, the 
  model.saveas command saves the model with the new filename, copies its 
  adjacency and shading table files, then updates the stored model filename
  and the main window caption.</p>
  <p>Parameter(s)</p>
  <p>filename Specifies the filename to use for the dump; however, be aware
  of the issues with backslashes in filename parameters. It is generally 
  good practice to specify a directory location in addition to the 
  filename, or the export file will be saved to current model directory by 
  default.</p>
  <p>Here is an example:</p>
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>dump(<span class="py-string">&quot;C:\Test\mytest.eco&quot;</span>)</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="export_file"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">export_file</span>(<span class="sig-arg">filename</span>,
        <span class="sig-arg">fileformat</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#export_file">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to export the current model data to the a file. A 
  suffix component can be used to specify the file format, as given in the 
  following table. By default, the file(s) will be saved to the disk. 
  However, for some of the formats marked with [run.], if you insert the 
  prefix run. in front of the file type token, ECOTECT will automatically 
  invoke the last action for the export and actually run the associated 
  application to process the exported file. For example, the examples given
  below show exports to Radiance. With the model.export.run.rad command, 
  Radiance will be involked to actually generate the images defined within 
  the exported Radiance file.</p>
  <p>Parameter(s)</p>
  <p>filename Specifies the filename to use for the export. However, be 
  aware of the issues with backslashes in filename parameters. It is 
  generally good practice to specify a directory location in addition to 
  the filename, or the export file will be saved to current model directory
  by default.</p>
  <p>Extension Read Write Format mod yes yes ASCII Model File rad yes yes 
  RADIANCE Scene File oct no yes RADIANCE Octree pov no yes POV-Ray Scene 
  File wrl yes yes VRML 2.0 FIle dxf yes yes AutoCAD DXF File htb no yes 
  HTB2 Model File nat no yes NatHERS Model File esp no yes ESP-r Model File
  ray yes yes Binary Acoustic Rays File grd yes yes Binary Analysis Grid 
  File cfd no yes NIST FDS CFD Model File air no yes WinAir 4 CFD Model 
  File wmf no yes Windows Metafile Image File bmp yes yes Windows Bitmap 
  Image File jpg yes yes JPEG Image File gif yes yes GIF Image File scr yes
  no ECOTECT Script File csv yes yes Comma Separated Value (CSV) File asc 
  yes yes ASCII Text File dat yes yes RADIANCE Point Data File chm no no 
  Microsoft Compiled Help File msk yes yes Shanding Mask File idf yes yes 
  EnergyPlus Input File eio yes no EnergyPlus Summary File eso yes no 
  EnergyPlus Binary Output txt yes yes ASCII Text File</p>
  <p>Here is an example:</p>
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>export_file(<span class="py-string">&quot;D:\Temp\mytest.dxf&quot;</span>, <span class="py-string">&quot;.dxf&quot;</span>)</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="import_file"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">import_file</span>(<span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#import_file">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to import data in into the current model. A suffix 
  component can be used to specify the the file format from the following 
  table.</p>
  <p>The Ecotect version of this command is: model.import</p>
  <p>Parameter(s)</p>
  <p>filename Specifies the filename to use for the import. However, be 
  aware of the issues with backslashes in filename parameters. It is 
  generally good practice to specify a directory location in addition to 
  the filename, or the import file will be saved to current model directory
  by default.</p>
  <p>Extension Read Write Format mod yes yes ASCII Model File rad yes yes 
  RADIANCE Scene File oct no yes RADIANCE Octree pov no yes POV-Ray Scene 
  File wrl yes yes VRML 2.0 FIle dxf yes yes AutoCAD DXF File htb no yes 
  HTB2 Model File nat no yes NatHERS Model File esp no yes ESP-r Model File
  ray yes yes Binary Acoustic Rays File grd yes yes Binary Analysis Grid 
  File cfd no yes NIST FDS CFD Model File air no yes WinAir 4 CFD Model 
  File wmf no yes Windows Metafile Image File bmp yes yes Windows Bitmap 
  Image File jpg yes yes JPEG Image File gif yes yes GIF Image File scr yes
  no ECOTECT Script File csv yes yes Comma Separated Value (CSV) File asc 
  yes yes ASCII Text File dat yes yes RADIANCE Point Data File chm no no 
  Microsoft Compiled Help File msk yes yes Shanding Mask File idf yes yes 
  EnergyPlus Input File eio yes no EnergyPlus Summary File eso yes no 
  EnergyPlus Binary Output txt yes yes ASCII Text File</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="load"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">load</span>(<span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#load">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Loads the specified file as the current model.</p>
  <p>Parameter(s)</p>
  <p>filename Specifies the name of the ECOTECT file to load. In most cases
  you will need to specify the full pathname of the file to be loaded, as 
  the directory in which the model file resides will become the current 
  directory in which the application will work. An example may be:</p>
  <p>filename =  C:\Temp\Test.eco</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="load_new"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">load_new</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#load_new">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Clears the current model from memory and resets the material library. 
  Note: when used as part of a script, this command will not prompt you to 
  save any changes you have made to the current model. Once called, all 
  changes will be lost.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <p>Command in ECOTECT: model.new</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="revert"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">revert</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#revert">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to revert to the last saved version of the current 
  model file. This can be useful where you have been running a long script 
  unattended that has made many changes to the model and do not want them 
  saved. Simply add a model.revert command at the end of the script and it 
  will reload the original.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="save"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">save</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#save">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This command simply saves the current model to disk. If the model does
  not already have a filename, the command will fail.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="save_as"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">save_as</span>(<span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#save_as">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>When invoked, the model.saveas command saves the model with the new 
  filename, copies its adjacency and shading table files, then updates the 
  stored model filename and the main window caption. As a comparison, the 
  model.dump command only saves a snapshot copy of the current model to the
  specified file, without changing the stored filename or marking the model
  as having been recently saved.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="update"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">update</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#update">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use the update command to check and refresh inter-object relationships
  within the model. Complex model with many inter-relationships can take a 
  little time to regenerate so ECOTECT doesn't do this automatically after 
  each script-based manipulation. You can also use object.update to do this
  specific objects in the model.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_altitude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_altitude</span>(<span class="sig-arg">absolute_position_start</span>,
        <span class="sig-arg">absolute_position_end</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_altitude">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves geometric information from the current ECOTECT model, 
  specifically the vertical angular distance of a line starting at (x1, y1,
  z1) and travelling towards var&gt;(x2, y2, z2). The value returned is 
  given in degrees.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>absolute_position_start A list of three values that represent the 
  absolute position in the X, Y and Z axis of a starting point in 3 
  dimensional model space.</p>
  <p>absolute_position_end A list of three values that represent the 
  absolute position in the X, Y and Z axis of an end point in 3 dimensional
  model space.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>alt The altitude angle in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_azimuth"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_azimuth</span>(<span class="sig-arg">absolute_position_start</span>,
        <span class="sig-arg">absolute_position_end</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_azimuth">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves geometric information from the current ECOTECT model, 
  specifically the horizontal angular distance of a line starting at (x1, 
  y1, z1) and travelling towards var&gt;(x2, y2, z2). The value returned is
  given in degrees.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>absolute_position_start A list of three values that represent the 
  absolute position in the X, Y and Z axis of a starting point in 3 
  dimensional model space.</p>
  <p>absolute_position_end A list of three values that represent the 
  absolute position in the X, Y and Z axis of an end point in 3 dimensional
  model space.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>azi The azimuth angle in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_current_node"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_current_node</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_current_node">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the zero-based index of the last selected node within the 
  currently loaded ECOTECT model.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>node The zero-based index of the current node.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_current_object"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_current_object</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_current_object">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the Szero-based index of the last selected object within the 
  currently loaded ECOTECT model.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>object The zero-based index of the current object in the model.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_current_zone"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_current_zone</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_current_zone">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the zero-based index of the current zone in the currently 
  loaded ECOTECT model. Thus, the Outside zone is always 0.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>model.currentzone The zero-based index of the current zone.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_date"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_date</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_date">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current date as a formatted string ready for printing or
  output to a file.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>day An integer value between 1 and 31.</p>
  <p>month An integer value between 0 and 11.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_date"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_date</span>(<span class="sig-arg">day</span>,
        <span class="sig-arg">month</span>,
        <span class="sig-arg">time</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_date">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the date in the ECOTECT model.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>day An integer value between 1 and 31.</p>
  <p>month An integer value between 0 and 11.</p>
  <p>[time] An optional decimal value between 0.0 and 23.99.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_date_string"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_date_string</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_date_string">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves a formated string containing the current model date.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>dateStr A formated date string.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_daylight_savings"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_daylight_savings</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_daylight_savings">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the status of the daylight savings flag.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state The daylight savings setting given as a boolean value where 1 
  represents the affirmative and 0 the negative. When true, the current 
  time is offset by one hour.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_daylight_savings"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_daylight_savings</span>(<span class="sig-arg">state</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_daylight_savings">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the status of the daylight savings flag.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>[state] Sets the daylight savings flag. This is a boolean value where 
  1 or true represents the affirmative and 0 or false the negative. When 
  set to true, the current time is offset by one hour.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_day_of_the_year"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_day_of_the_year</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_day_of_the_year">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current date and displays it in the julian date format, 
  where a single integer value between 1 and 365 represents a day of the 
  year.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>day An integer value between 1 and 365 that represents a day of the 
  year.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_day_of_the_year"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_day_of_the_year</span>(<span class="sig-arg">day</span>,
        <span class="sig-arg">time</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_day_of_the_year">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the current date using the julian date format.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>day An integer value between 1 and 365 that represents a day of the 
  year.</p>
  <p>[time] This optional parameter is a decimal hour between 0.0 and 
  23.99.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_directory"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_directory</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_directory">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the drive and directory in which the currently loaded ECOTECT 
  model is located. This is essentially the full pathname, but without the 
  filename component.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>path A text string containing the current directory path.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_directory"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_directory</span>(<span class="sig-arg">path</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_directory">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the drive and directory to use with the currently loaded ECOTECT 
  model.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>path A string value that defines the directory to use. Include both 
  the drive letter and full directory path. However, be aware of the issues
  with backslashes in filename parameters as described in the ECOTECT help 
  file.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_display"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_display</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_display">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current information display. When retrieving this value,
  a single integer value is returned corresponding to items in the Model 
  Display table.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>display What information is displayed in the model. This is given as 
  an integer value from the Model Display table below.</p>
  <p>Token Value Description model 0 Default model only. shadows 1 Shadows 
  and reflections normals 2 Surface normals. sketch 3 Sketched view. 
  winddata 5 Wind distribution data. sprayedrays 7 Sprayed acoustic rays. 
  values 8 Object attribute values. zonetemps 9 Zone temperatures rays 10 
  Acoustic rays and particles.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_display"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_display</span>(<span class="sig-arg">display</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_display">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This property sets the current information display.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>display Sets what information to display in the model. This can be 
  specified as either a token or value parameter, as outlined in the Model 
  Display table below.</p>
  <p>Token Value Description model 0 Default model only. shadows 1 Shadows 
  and reflections normals 2 Surface normals. sketch 3 Sketched view. 
  winddata 5 Wind distribution data. sprayedrays 7 Sprayed acoustic rays. 
  values 8 Object attribute values. zonetemps 9 Zone temperatures rays 10 
  Acoustic rays and particles.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_distance"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_distance</span>(<span class="sig-arg">absolute_position_start</span>,
        <span class="sig-arg">absolute_position_end</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_distance">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves geometric information from the current ECOTECT model, 
  specifically the distance between two points, starting at (x1, y1, z1) 
  and ending at (x2, y2, z2). The value returned is given in the current 
  units.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>absolute_position_start A list of three values that represent the 
  absolute position in the X, Y and Z axis of a starting point in 3 
  dimensional model space.</p>
  <p>absolute_position_end A list of three values that represent the 
  absolute position in the X, Y and Z axis of an end point in 3 dimensional
  model space.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>dist The distance value in the current model units.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_filename"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_filename</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_filename">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the filename of the currently loaded ECOTECT model. This is 
  the filename only, with no drive or directory components.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>filename A text string containing the filename.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_last_node_index"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_last_node_index</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_last_node_index">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the zero-based index of the last added/inserted node within 
  the currently loaded ECOTECT model.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>node The zero-based index of the last created or inserted node. If no 
  such node exists, a value of -1 is returned.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="num_materials"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">num_materials</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#num_materials">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the number of materials stored in the currently loaded ECOTECT
  model.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>count The total number of materials defined within the current model's
  element library.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_month"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_month</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_month">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the current month.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>month The current model month given as an integer index between 0 and 
  11.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_next_node"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_next_node</span>(<span class="sig-arg">object</span>,
        <span class="sig-arg">node</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_next_node">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the zero-based absolute index of the next node in the 
  specified object, in relation to the current node.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>object The object to use.</p>
  <p>index The node within the current object to use.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>node The zero-based index of the next node. If no matching node is 
  found, a value of -1 is returned.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_next_object"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_next_object</span>(<span class="sig-arg">startat</span>,
        <span class="sig-arg">type</span>,
        <span class="sig-arg">flag</span>,
        <span class="sig-arg">tag</span>,
        <span class="sig-arg">zone</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_next_object">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this property to obtain the zero-based index of the next object 
  matching the type, flag and tag values specified.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>startat The index value to start searching from. To search from the 
  start, use a value of -1.</p>
  <p>type The element type, as outlined in the Element Types table below. 
  To ignore this parameter, enter it as a negative value, such as -1.</p>
  <p>flag The integer flags from the Object Flags table. To combine 
  multiple flag values, add their numeric values together. To ignore this 
  parameter, enter it as a negative value, such as -1.</p>
  <p>tag The integer tag parameter from the Object Tags table. To combine 
  multiple tag values, add their numeric values together. To ignore this 
  parameter, enter it as a negative value, such as -1.</p>
  <p>zone The zone to which the object must belong. To ignore this 
  parameter, enter it as a negative value, such as -1.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>object The zero-based index of the next object found. If no matching 
  object is found, a value of -1 is returned.</p>
  <p>Element Types Token Value void 0 roof 1 floor 2 ceiling 3 wall 4 
  partition 5 window 6 panel 7 door 8 point 9 speaker 10 light 11 appliance
  12 line 13 solarcollector 14 camera 15</p>
  <p>Object Flag Codes Value Description 1 Object is a single-node point. 2
  Object is a direction vector. 4 Object is a flat surface with an 
  equation. 8 Objects is a closed loop. 16 Object defines a virtual 
  polyline. 32 Object is formed from the extrusion of its parent. 64 Object
  has been extruded. 128 Object is linked to another as coplanar. 256 
  Object is linked to another as inside its extents. 512 Object is a 
  complex/concave polygon. 1024 Object is the parent of another. 2048 
  Object is the child of another. 4096 Object defines a model zone. 8192 
  *User has specified particular nodes to generate equation. 16384 Object's
  surface normal is reversed. 32768 Object is partially transparent.</p>
  <p>Object Tag Codes Value Description 1 *User clicked near one of its 
  lines. 2 *Part of the previous selection set. 16 Object has valid 
  assigned attribute data. 32 Shadows are cast onto this object. 256 Object
  produces solar reflections. 512 Object is tagged as an acoustic 
  reflector. 4096 Not used. 32768 *Generic calculation marker.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_orientation"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_orientation</span>(<span class="sig-arg">absolute_position_start</span>,
        <span class="sig-arg">absolute_position_end</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_orientation">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves geometric information from the current ECOTECT model, 
  specifically the relative horizontal angle from North of a line starting 
  at (x1, y1, z1) and travelling towards var&gt;(x2, y2, z2). The value 
  returned is given in a positive clockwise direction.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>absolute_position_start A list of three values that represent the 
  absolute position in the X, Y and Z axis of a starting point in 3 
  dimensional model space.</p>
  <p>absolute_position_end A list of three values that represent the 
  absolute position in the X, Y and Z axis of an end point in 3 dimensional
  model space.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>ori The orinetation angle in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_origin"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_origin</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_origin">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the location of the Transformation Origin. This is a dynamic
  point about which objects are rotated, scaled or mirrored.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>x, y, z Represents the absolute position in the X, Y and Z axis of a 
  point in 3 dimensional model space.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_origin"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_origin</span>(<span class="sig-arg">absolute_position</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_origin">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the location of the Transformation Origin. This is a dynamic 
  point about which objects are rotated, scaled or mirrored.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>absolute_position A list of three values that represent the absolute 
  position in the X, Y and Z axis of a point in 3 dimensional model 
  space.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_path_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_path_name</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_path_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the full pathname of the currently loaded ECOTECT model. This 
  includes the full drive, directory and filename specification.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>pathname A text string containing the full pathname.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_prev_node"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_prev_node</span>(<span class="sig-arg">object</span>,
        <span class="sig-arg">node</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_prev_node">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the zero-based absolute index of the previous node in the 
  specified object, in relation to the current node.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>object The object to use.</p>
  <p>index The current node in the current object to use.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>node The zero-based index of the previous node. If no matching node is
  found, a value of -1 is returned.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_prev_object"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_prev_object</span>(<span class="sig-arg">startat</span>,
        <span class="sig-arg">type</span>,
        <span class="sig-arg">flag</span>,
        <span class="sig-arg">tag</span>,
        <span class="sig-arg">zone</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_prev_object">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this property to obtain the zero-based index of the preceding 
  object matching the type, flag and tag values specified.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>startat The index value to start searching from. To search from the 
  start, use a value of -1.</p>
  <p>type This refers to the element type, as outlined in the Element Types
  table. To ignore this parameter, enter it as a negative value such as 
  -1.</p>
  <p>flag This parameter refers to the items in the Object Flags table. To 
  combine multiple flag values, simply add their numeric values together. 
  To ignore this parameter, enter it as a negative value such as -1.</p>
  <p>tag This parameter refers to the items in the Object Tags table. To 
  combine multiple tag values, simply add their numeric values together. To
  ignore this parameter, enter it as a negative value such as -1.</p>
  <p>zone The zone to which the object must belong. To ignore this 
  parameter, enter it as a negative value such as -1.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>object The zero-based index of the next object found. If no matching 
  object is found, a value of -1 is returned.</p>
  <p>Element Types Token Value void 0 roof 1 floor 2 ceiling 3 wall 4 
  partition 5 window 6 panel 7 door 8 point 9 speaker 10 light 11 appliance
  12 line 13 solarcollector 14 camera 15</p>
  <p>Object Flag Codes Value Description 1 Object is a single-node point. 2
  Object is a direction vector. 4 Object is a flat surface with an 
  equation. 8 Objects is a closed loop. 16 Object defines a virtual 
  polyline. 32 Object is formed from the extrusion of its parent. 64 Object
  has been extruded. 128 Object is linked to another as coplanar. 256 
  Object is linked to another as inside its extents. 512 Object is a 
  complex/concave polygon. 1024 Object is the parent of another. 2048 
  Object is the child of another. 4096 Object defines a model zone. 8192 
  *User has specified particular nodes to generate equation. 16384 Object's
  surface normal is reversed. 32768 Object is partially transparent.</p>
  <p>Object Tag Codes Value Description 1 *User clicked near one of its 
  lines. 2 *Part of the previous selection set. 16 Object has valid 
  assigned attribute data. 32 Shadows are cast onto this object. 256 Object
  produces solar reflections. 512 Object is tagged as an acoustic 
  reflector. 4096 Not used. 32768 *Generic calculation marker.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_snap"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_snap</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_snap">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current information display</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>display What information is displayed in the model. This is given as 
  an integer value from the Model Display table below.</p>
  <p>Relevant Data Table(s)</p>
  <p>Model Display Options Token Value Description model 0 Default model 
  only. shadows 1 Shadows and reflections normals 2 Surface normals. sketch
  3 Sketched view. winddata 5 Wind distribution data. sprayedrays 7 Sprayed
  acoustic rays. values 8 Object attribute values. zonetemps 9 Zone 
  temperatures rays 10 Acoustic rays and particles</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_snap"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_snap</span>(<span class="sig-arg">snap</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_snap">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">


This property sets the current information display. 

Parameter(s)
This property takes the following parameters.

display 
Sets what information to display in the model. This can be specified as
 either a token or value parameter, as outlined in the Model Display
  table below. 

Relevant Data Table(s)

Model Display Options
 Token Value Description 
model 0 Default model only. 
shadows 1 Shadows and reflections 
normals 2 Surface normals. 
sketch 3 Sketched view. 
winddata 5 Wind distribution data. 
sprayedrays 7 Sprayed acoustic rays. 
values 8 Object attribute values. 
zonetemps 9 Zone temperatures 
rays 10 Acoustic rays and particles. 

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_sun_angles"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_sun_angles</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_sun_angles">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns two values, being the azimuth and altitude of the Sun for the 
  current date and time, given in decimal degrees.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>azi The current solar azimuth given in degrees.</p>
  <p>alt The current solar altitude given in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_sun_position"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_sun_position</span>(<span class="sig-arg">dist</span>=<span class="sig-default">0</span>,
        <span class="sig-arg">xyz</span>=<span class="sig-default"><code class="variable-group">(</code>0<code class="variable-op">, </code>0<code class="variable-op">, </code>0<code class="variable-group">)</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_sun_position">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns a position value that can be used to represent the Sun 
  location relative to the model. This is useful is you wish to locate a 
  Sun position relative to the centre of a WINDOW in order to spray a ray 
  or do a visibility test, for example.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>[dist] The optional distance the Sun will be placed from the centre of
  the model.</p>
  <p>[x, y, z] A list of three values. If these optional parameters are 
  given, the Sun position will be generated at a location dist away from 
  this position, using the current Sun angles in the model.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>x, y, z Represents the absolute position in the X, Y and Z axis of the
  Sun in 3 dimensional model space.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_sunrise"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_sunrise</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_sunrise">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the sunrise time as a 24 hour decimal value. Thus, 6:30am 
  would be returned as 6.5.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>sunrise The time of sunrise given as a decimal hour.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_sun_set"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_sun_set</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_sun_set">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the sunset time as a 24 hour decimal value. Thus, 6:30pm would
  be returned as 18.5.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>sunset The time of sunset given as a decimal hour.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_time"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_time</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_time">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current time of day. The time value returned is a 
  decimal value between 0.0 and 23.99.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>time A decimal value between 0.0 and 23.99.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_time"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_time</span>(<span class="sig-arg">time</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_time">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the current time of day.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>time The time given in decimal hours, between 0.0 and 23.99.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_time_string"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_time_string</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_time_string">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves a formated string containing the current model time.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>timeStr A formated time string.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_flag_cap_extrusions"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_flag_cap_extrusions</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_flag_cap_extrusions">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the capextrusions flag. When capextrusions is set to true or
  1, extruding an object automatically generates a top or 'lid' to cap off 
  the volume. When set to false or 0, no lid is generated.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state A boolean value where 1 represents the affirmative and 0 the 
  negative.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_flag_cap_extrusions"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_flag_cap_extrusions</span>(<span class="sig-arg">state</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_flag_cap_extrusions">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the capextrusions flag.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>[state] When set to true, extruding an object automatically generates 
  a top or 'lid' to cap off the volume. When set to false, no lid is 
  generated.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_flag_vectors"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_flag_vectors</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_flag_vectors">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the xform.vectors flag. With transform vectors set to true 
  or 1, rotating an object with offset-linked children will also rotate the
  offset vector. When set to false or 0, the offset vector remains the same
  even though each object rotates individually.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state A boolean value where 1 represents the affirmative and 0 the 
  negative.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_flag_vectors"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_flag_vectors</span>(<span class="sig-arg">state</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#set_flag_vectors">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the number of zones in the currently loaded ECOTECT model as a
  single integer.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>count The total number of zones in the current model.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_num_nodes"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_num_nodes</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_num_nodes">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the number of individual object nodes within the currently 
  loaded ECOTECT model.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>count The total number of nodes within the current model.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_num_objects"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_num_objects</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_num_objects">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the number of objects in the currently loaded ECOTECT 
  model.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>count The total number of objects in the current model.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>count The total number of objects in the current model.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_zones"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_zones</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.model-pysrc.html#get_zones">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the number of zones in the currently loaded ECOTECT model as a
  single integer.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>count The total number of zones in the current model.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:47 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
